Package com.cisco.pt.ipc.ui.impl
Class PhysicalObjectImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.ui.impl.PhysicalObjectImpl
- All Implemented Interfaces:
IPCObject,PhysicalObject
Information provided by the PKI file:
\class PhysicalObject
\brief An object in the Physical Workspace.
\example appWindow().getActiveWorkspace().getRootPhysicalObject()
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionPhysicalObjectImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionInformation provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:getChildAt(int index) Information provided by the PKI file:getChildByPath(String path) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:doubleInformation provided by the PKI file:doubleInformation provided by the PKI file:doublegetName()Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:getType()Information provided by the PKI file:doublegetWidth()intgetX()Information provided by the PKI file:doubleintgetY()Information provided by the PKI file:doublevoidmoveBy(int x, int y) Information provided by the PKI file:booleanmoveIntoObject(String name) Information provided by the PKI file:booleanInformation provided by the PKI file:voidmoveTo(int x, int y) Information provided by the PKI file:nameToUuidPath(String namePath) Information provided by the PKI file:voidsetBackground(String path, boolean tiled) Information provided by the PKI file:voidsetVelocity(double xv, double yv) Information provided by the PKI file:voidsetX(int x) voidsetXVelocity(double xv) Information provided by the PKI file:voidsetY(int y) Information provided by the PKI file:voidsetYVelocity(double yv) Information provided by the PKI file:uuidToNamePath(String uuidPath) Information provided by the PKI file:doubleInformation provided by the PKI file:doubleInformation provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
PhysicalObjectImpl
public PhysicalObjectImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getName
Information provided by the PKI file:
\brief Returns the name of this physical object \return QString, name of the object.- Specified by:
getNamein interfacePhysicalObject- Returns:
- String Returns a String
-
getType
Information provided by the PKI file:
\brief Returns the type of physical object. INTER_CITY = 0, CITY = 1, BUILDING = 2, WIRING_CLOSET = 3, RACK = 4, TABLE = 5, DEVICE = 6 MULTIUSER = 7, GENERIC_CONTAINER = 8, \return PhysicalObjectType- Specified by:
getTypein interfacePhysicalObject- Returns:
- PhysicalObjectType Returns a PhysicalObjectType
-
getX
public int getX()Information provided by the PKI file:
\brief Returns X coordinate. \return int, x coordinate.- Specified by:
getXin interfacePhysicalObject- Returns:
- int Returns a int
-
getY
public int getY()Information provided by the PKI file:
\brief Returns Y coordinate. \return int, y coordinate.- Specified by:
getYin interfacePhysicalObject- Returns:
- int Returns a int
-
getCenterX
public int getCenterX()Information provided by the PKI file:
\brief Returns center X coordinate. \return int, center x coordinate.- Specified by:
getCenterXin interfacePhysicalObject- Returns:
- int Returns a int
-
getCenterY
public int getCenterY()Information provided by the PKI file:
\brief Returns center Y coordinate. \return int, center Y coordinate.- Specified by:
getCenterYin interfacePhysicalObject- Returns:
- int Returns a int
-
getGlobalX
public double getGlobalX()Information provided by the PKI file:
\brief Returns global X coordinate. \return double, global x coordinate.- Specified by:
getGlobalXin interfacePhysicalObject- Returns:
- double Returns a double
-
getGlobalY
public double getGlobalY()Information provided by the PKI file:
\brief Returns global Y coordinate. \return double, global Y coordinate.- Specified by:
getGlobalYin interfacePhysicalObject- Returns:
- double Returns a double
-
getDevice
Information provided by the PKI file:
\brief Returns the device if the type is DEVICE \return Device, the device in the object type is DEVICE.- Specified by:
getDevicein interfacePhysicalObject- Returns:
- Device Returns a Device
-
getParent
Information provided by the PKI file:
\brief Returns the parent that contains the physical object. \return PhysicalObject, the parent that contains the physical object.- Specified by:
getParentin interfacePhysicalObject- Returns:
- PhysicalObject Returns a PhysicalObject
-
moveOutOfCurrentObject
public boolean moveOutOfCurrentObject()Information provided by the PKI file:
\brief Moves the physical object out of the current parent object and returns whether it was successful. \return boolean, whether the move was successful.- Specified by:
moveOutOfCurrentObjectin interfacePhysicalObject- Returns:
- boolean Returns a boolean
-
moveIntoObject
Information provided by the PKI file:
\brief Moves the physical object into an object in the same level with the specified name and returns whether it was successful. \param name, the name of the object in the same level \return boolean, whether the move was successful.- Specified by:
moveIntoObjectin interfacePhysicalObject- Parameters:
name- Takes in a parameter of name- Returns:
- boolean Returns a boolean
-
getChildCount
public int getChildCount()Information provided by the PKI file:
\brief Returns the number of children the physical object has. \return int, the number of children the physical object has.- Specified by:
getChildCountin interfacePhysicalObject- Returns:
- int Returns a int
-
getChildAt
Information provided by the PKI file:
\brief Returns the child at the given index in the physical object. \param index, index to get a child from. \return PhysicalObject, the child at the given index, if any.- Specified by:
getChildAtin interfacePhysicalObject- Parameters:
index- Takes in a parameter of index- Returns:
- PhysicalObject Returns a PhysicalObject
-
getChild
Information provided by the PKI file:
\brief Returns the child with the specified name in the physical object. \param name, name of the child. \return PhysicalObject, the child with the specified name, if any.- Specified by:
getChildin interfacePhysicalObject- Parameters:
name- Takes in a parameter of name- Returns:
- PhysicalObject Returns a PhysicalObject
-
getChildByPath
Information provided by the PKI file:
\brief Returns the child recursively with the specified path separated by comma (,) in the physical object. \param path, path of the child separated by comma (,). \return PhysicalObject, the child with the specified path, if any.- Specified by:
getChildByPathin interfacePhysicalObject- Parameters:
path- Takes in a parameter of path- Returns:
- PhysicalObject Returns a PhysicalObject
-
setBackground
Information provided by the PKI file:
\brief Sets the background image path to use when inside the physical object. \param path, path to the image to use. \param tiled, true to tile the background false to just show one image.- Specified by:
setBackgroundin interfacePhysicalObject- Parameters:
path- Takes in a parameter of pathtiled- Takes in a parameter of tiled
-
getBackground
Information provided by the PKI file:
\brief Sets the background image path to use when inside the physical object. \return QString, the background image path.- Specified by:
getBackgroundin interfacePhysicalObject- Returns:
- String Returns a String
-
getEnvironment
Information provided by the PKI file:
\brief Gets the environment for the physical object. \return Environment, the environment for the physical object.- Specified by:
getEnvironmentin interfacePhysicalObject- Returns:
- Environment Returns a Environment
-
setX
public void setX(int x) - Specified by:
setXin interfacePhysicalObject- Parameters:
x- Takes in a parameter of x
-
setY
public void setY(int y) Information provided by the PKI file:
\brief Sets the y-coordinate of the component item. \param y, the y-coordinate of the component item.- Specified by:
setYin interfacePhysicalObject- Parameters:
y- Takes in a parameter of y
-
moveBy
public void moveBy(int x, int y) Information provided by the PKI file:
\brief Moves the component item by the specified x and y values. \param x, the value to move the component item by on the x-axis. \param y, the value to move the component item by on the y-axis.- Specified by:
moveByin interfacePhysicalObject- Parameters:
x- Takes in a parameter of xy- Takes in a parameter of y
-
moveTo
public void moveTo(int x, int y) Information provided by the PKI file:
\brief Moves the component item to the specified coordinates. \param x, the value to move the component item to on the x-axis. \param y, the value to move the component item to on the y-axis.- Specified by:
moveToin interfacePhysicalObject- Parameters:
x- Takes in a parameter of xy- Takes in a parameter of y
-
getXScale
public double getXScale()- Specified by:
getXScalein interfacePhysicalObject- Returns:
- double Returns a double
-
getYScale
public double getYScale()- Specified by:
getYScalein interfacePhysicalObject- Returns:
- double Returns a double
-
getWidth
public double getWidth()- Specified by:
getWidthin interfacePhysicalObject- Returns:
- double Returns a double
-
getHeight
public double getHeight()- Specified by:
getHeightin interfacePhysicalObject- Returns:
- double Returns a double
-
setXVelocity
public void setXVelocity(double xv) Information provided by the PKI file:
\brief Sets the x-axis velocity of the component item. \param xv, the x-axis velocity of the component item.- Specified by:
setXVelocityin interfacePhysicalObject- Parameters:
xv- Takes in a parameter of xv
-
setYVelocity
public void setYVelocity(double yv) Information provided by the PKI file:
\brief Sets the y-axis velocity of the component item. \param yv, the y-axis velocity of the component item.- Specified by:
setYVelocityin interfacePhysicalObject- Parameters:
yv- Takes in a parameter of yv
-
setVelocity
public void setVelocity(double xv, double yv) Information provided by the PKI file:
\brief Sets the x-axis and y-axis velocity of the component item. \param xv, the x-axis velocity of the component item. \param yv, the y-axis velocity of the component item.- Specified by:
setVelocityin interfacePhysicalObject- Parameters:
xv- Takes in a parameter of xvyv- Takes in a parameter of yv
-
xVelocity
public double xVelocity()Information provided by the PKI file:
\brief Returns the x-axis velocity of the component item. \return double, the x-axis velocity of the component item.- Specified by:
xVelocityin interfacePhysicalObject- Returns:
- double Returns a double
-
yVelocity
public double yVelocity()Information provided by the PKI file:
\brief Returns the y-axis velocity of the component item. \return double, the y-axis velocity of the component item.- Specified by:
yVelocityin interfacePhysicalObject- Returns:
- double Returns a double
-
getPathUuid
Information provided by the PKI file:
\brief Returns the UUID of the physical object \return QString, the UUID of the physical object- Specified by:
getPathUuidin interfacePhysicalObject- Returns:
- String Returns a String
-
nameToUuidPath
Information provided by the PKI file:
\brief Returns the comma-separated UUID path of the physical object from the given comma-separated physical location name path \return QString, the comma-separated UUID path of the physical object from the given comma-separated physical location name path- Specified by:
nameToUuidPathin interfacePhysicalObject- Parameters:
namePath- Takes in a parameter of namePath- Returns:
- String Returns a String
-
uuidToNamePath
Information provided by the PKI file:
\brief Returns the comma-separated name path of the physical object from the given comma-separated physical location UUID path \return QString, the comma-separated name path of the physical object from the given comma-separated physical location UUID path- Specified by:
uuidToNamePathin interfacePhysicalObject- Parameters:
uuidPath- Takes in a parameter of uuidPath- Returns:
- String Returns a String
-